'\" te
.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH DI_WALK_LNODE 3DEVINFO "Mar 22, 2004"
.SH NAME
di_walk_lnode \- traverse libdevinfo lnodes
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldevinfo\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <libdevinfo.h>

\fBint\fR \fBdi_walk_lnode\fR(\fBdi_node_t\fR \fIroot\fR, \fBuint_t\fR \fIflag\fR, \fBvoid *\fR\fIarg\fR,
     \fBint (*\fR\fIlnode_callback\fR)(di_lnode_t \fIlink\fR, void *\fIarg\fR));
.fi

.SH PARAMETERS
.sp
.ne 2
.na
\fB\fIroot\fR\fR
.ad
.RS 18n
The handle to the root node of the subtree to visit.
.RE

.sp
.ne 2
.na
\fB\fIflag\fR\fR
.ad
.RS 18n
Specify 0. Reserved for future use.
.RE

.sp
.ne 2
.na
\fB\fIarg\fR\fR
.ad
.RS 18n
A pointer to caller-specific data.
.RE

.sp
.ne 2
.na
\fB\fIlnode_callback\fR\fR
.ad
.RS 18n
The caller-supplied callback function.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBdi_walk_lnode()\fR function visits all nodes in the subtree rooted at
\fIroot\fR.  For each node found, the caller-supplied function
\fIlnode_callback\fR() is invoked for each lnode associated with that node.
The return value of \fIlnode_callback\fR() specifies subsequent walking
behavior where that node is the specified \fIendpoint\fR of the link.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, \fBdi_walk_lnode()\fR returns 0.  Otherwise, -1 is
returned and \fBerrno\fR is set to indicate the error.
.sp
.LP
The callback function \fIlnode_callback\fR() can return one of the following:
.sp
.ne 2
.na
\fB\fBDI_WALK_CONTINUE\fR\fR
.ad
.RS 21n
Continue walking.
.RE

.sp
.ne 2
.na
\fB\fBDI_WALK_TERMINATE\fR\fR
.ad
.RS 21n
Terminate the walk immediately.
.RE

.SH ERRORS
.sp
.LP
The \fBdi_walk_lnode()\fR function will fail if:
.sp
.ne 2
.na
\fB\fBEINVAL\fR\fR
.ad
.RS 10n
An argument is invalid.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Evolving
_
MT-Level	Safe
.TE

.SH SEE ALSO
.sp
.LP
.BR di_init (3DEVINFO),
.BR libdevinfo (3LIB),
.BR attributes (7)
